Scrapbox to Markdown テストコード設計

impl5

bra

layer

json

raw scb

markdown

json使ってテストする

exportして手元に持ってくる

scbjson2ghpages.pyに食わせる

これだけだと全部読み込みで使いづらい

指定ページのnormalized scbを返すようにする？

normalized scbで書かれた指定ファイルを使ってテストする

ファイルは適当に用意して

scbjson2ghpages.pyに食わせることができるようにする？

でも製品にテスト用機能搭載するって違くない？

普通にtest_lib_scblines2markdown.pyからreadすればいいのでは

json何回もexportし直してなおしてってのはだるいからやめたい

テストのレイヤー

unittest

lib_*.pyの各変換機能とか

unittestライブラリでできる

ここはファイル I/Oせずにテストデータをハードコードすればいい

function test

jsonの特定ページがexpectと完全一致するかをたしかめる

ここは全体を一気通貫で見たいからI/Oも必要

テストコードで処理したいときってどうすればいいんだ？

linuxのdiffコマンド？

自力で「ファイル読んで内容比較するコード」つくる？

deploy test

実際にghpagesにデプロイする

これは手作業で見てみて「うん、できてるな」するしかなくない？

これは一つのghpagesとして公開しちゃう

diffコマンド例

code:terminal

$ diff 2_page_expect.md 3_page_actual_step3.md

131a132,134

<br>

leftのファイルに131行目に対して add をすると、rightのファイルの132～134行目の内容になります

code:見方

(before)

---

(after)

code:before省略時

(after)

だから、step3の方が三行ほど余分やで、と言っている

完全一致すればstdoutはゼロ（同じファイルを二つ食わせるとわかる）

直近ではcodeやtableをかんたんにテストする手段がほしい

これはバージョン管理する？

1_page_input.scb

2_page_expect.md

これはしない

3_page_actual_step1.md

3_page_actual_step2.md

3_page_actual_step3.md

一般化すると

table:一般化

1_(pagename)_input.scb normalized scbを記したファイル

2_(pagename)_expect.md 1を変換するとこうなるはずだ、という期待値

3_(pagename)_actual_step1.md 1を変換したらこうなった、という実際の値(step1部分)

3_(pagename)_actual_step2.md 同上、step1後のstep2

3_(pagename)_actual_step3.md 同上、step2後のstep3であり完成形（これがexpectと一致すればよい）

step1,2は最悪要らないが、あればデバッグ時に役立つので置いとく（gitignoreしてるのであってもかまわん）

pagenameバリエーション

table:variation

page 今使ってる「リストの塊」と「基本的な文法」を網羅したもの

? コード記法

? テーブル記法

? 画像系

unittest……はもうできてる

必要なら適当にCRUDできる

deploy test……は、まだまだ後

function test……が、UI整備されてない

pagenameに当たる部分をつくる

自由に切り替えられるようにする

jsonとは切り離した方がいいか？

こうかな

2: export to json

3: ローカルに持ってきて、本体に加えて、to raw オプションで .scb ファイルに吐く

このscbファイルを 1_input.scb にする

テストのレイヤー分け直します

unit test

一般的なunittest

部品がちゃんと動くかのテスト

unittestライブラリで完結させる

page test

page1つの変換がexpectと完全一致するかを試すテスト

テストデータはファイルとして準備しておくが、テストコードで動作完結できる

project test

projectの変換がちゃんとできてるかを試すテスト

ページ数 = ファイル数くらいはテストコードで調べてもいいかもしれん

jsonを加えて、ちゃんと全部markdownで吐かれてるかを見る

index.mdが意図通りになってるかはちゃんと見るべき

deploy test

page testの手段設計

test_pagetest.py？

test_page.pyだと「ページをテストする」でわかりづらいので「page testをテストする」ってことでこれでよい

テストデータはディレクトリ分けよう

testdata/ でいいか

テストコード自体はいったん直下に置いてしまう

./

scbjson2ghpages.py

test_pagetest.py

testdata/

1_codeblock_input.scb

1_page_input.scb

2_codeblock_expect.md

2_page_expect.md

....

expect actual の比較方法は？

手作業やwinmergeでも見たいから、ファイルには出したい

3_*.mdを出すよな

でもテスト自体はコード実行するだけで完結させたい

diffコマンドをos.systemで実行（行儀悪い）

完全一致 or notであれば、コードで書ける

listとlistの比較をすればいい

たしかpythonだと簡単にできたはず

で、「完全一致じゃない」だったら、手作業でwinmergeとかで見る

さすがに「どこがどう違うか」の表示を車輪の再発明するのはエグい

いけそうやな

んでは整備・実装していきましょー

ok